Update section 4 by rogerkuou · Pull Request #8 · esciencecenter-digital-skills/python-intermediate-development

rogerkuou · 2025-11-12T11:46:48Z

Fix #7

Now 4.2 focuses more on "re-use", including topics: documentation, pyproject.toml, cff file, license

4.3 focuses more one "release", including topics: version tagging, packaging.

Major changes:

4.1 Code review

Move the command line merging here

4.2 Preparing Software for Reuse

At beginning, mention working in a branch
remove "release" related parts and move it to 4.3
Keep the old README doc part
Add mkdocs to the docmentation part. Referencing: https://carpentries-incubator.github.io/good-practices-lesson/instructor/3-documentation.html
Teach basics on pyproject.toml file
Teachcff file
Move local cmd line merge part to 4.1 as a demonstration of command line method. Remove teaching command line merge to main, since this is not a good practice.

4.3 Code Release and Packaging

Move tagging to 4.3 since it is closely related to packaging
Update packaging technology to uv

github-actions · 2025-11-12T11:47:00Z

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

🎯 correct output
🖼️ correct figures
❓ new warnings
‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/esciencecenter-digital-skills/python-intermediate-development/compare/md-outputs..md-outputs-PR-8

The following changes were observed in the rendered markdown documents:

 41-code-review.md                           |  21 ++
 42-software-reuse.md                        | 481 +++++++++++++++++-----------
 43-software-release.md                      | 417 ++++++++++++------------
 fig/github-citation-file-rendered.png (new) | Bin 0 -> 81526 bytes
 fig/github-gh-page-settings.png (new)       | Bin 0 -> 96022 bytes
 md5sum.txt                                  |   6 +-
 6 files changed, 538 insertions(+), 387 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-11-17 20:19:13 +0000

rogerkuou · 2025-11-12T22:08:44Z

Hi @sjvrijn @jhidding @fnattino I have updated the Section 4 with the items mentioned in the description. Could you please have a look when you have time? Thanks!

sjvrijn

Good stuff! Commented a few fixes and suggestions so far.

episodes/42-software-reuse.md

episodes/43-software-release.md

Co-authored-by: Sander van Rijn <svr003@gmail.com>

rogerkuou · 2025-11-17T11:22:17Z

Hi @rogerkuou - very nice! Just spotted a couple of typos and left some minor suggestions - feel free to include only what you think makes sense (could also be merged as it is from my side).

thanks @fnattino ! I applied most of your comments. Feel free to have another look!

jhidding

Excellent work! I think a reference to the Python Packaging User Guide could be more prominent. It is now mentioned at the end, but maybe also at the beginning as the goto reference on the subject?

As regards the MkDocs Github action exercise suggestion, I think it could be nice to demo, but as an exercise would overload the amount of things people need to learn. There's a lot that comes together there, and no new concepts being tested.

fnattino

Looks great @rogerkuou !

rogerkuou · 2025-11-17T20:19:27Z

Excellent work! I think a reference to the Python Packaging User Guide could be more prominent. It is now mentioned at the end, but maybe also at the beginning as the goto reference on the subject?

As regards the MkDocs Github action exercise suggestion, I think it could be nice to demo, but as an exercise would overload the amount of things people need to learn. There's a lot that comes together there, and no new concepts being tested.

Thanks! I added a callout session metioning this guide at the begining.

Auto-generated via `{sandpaper}` Source : 585e9b8 Branch : main Author : Ou Ku <o.ku@esciencecenter.nl> Time : 2025-11-17 20:19:35 +0000 Message : Merge pull request #8 from esciencecenter-digital-skills/7_update_section_4_software_sustainability Update section 4

Auto-generated via `{sandpaper}` Source : 46bb9c8 Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2025-11-17 20:20:48 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : 585e9b8 Branch : main Author : Ou Ku <o.ku@esciencecenter.nl> Time : 2025-11-17 20:19:35 +0000 Message : Merge pull request #8 from esciencecenter-digital-skills/7_update_section_4_software_sustainability Update section 4

move command line git merge to 4.1

b2021ec

github-actions bot pushed a commit that referenced this pull request Nov 12, 2025

differences for PR #8

a989db4

move tagging to 4.3

a5b6226

github-actions bot pushed a commit that referenced this pull request Nov 12, 2025

differences for PR #8

f0adc08

rogerkuou added 3 commits November 12, 2025 14:11

consider develop branch

9e3a897

skeleton on mkdocs

23b7496

mkdocs descriptions

a1c3a48

github-actions bot pushed a commit that referenced this pull request Nov 12, 2025

differences for PR #8

47a8b65

update documentation aux description

0dd84af

rogerkuou changed the title ~~move command line git merge to 4.1~~ Update section 4 Nov 12, 2025

rogerkuou added 2 commits November 12, 2025 17:43

pyproject.toml

6d7a091

imporve wording

3a5c312

github-actions bot pushed a commit that referenced this pull request Nov 12, 2025

differences for PR #8

f57603d

rogerkuou added 3 commits November 12, 2025 19:34

update title of 4.2

50432ab

update tagging

cafeb8e

change from Poetry to uv

5ad248f

rogerkuou requested review from fnattino, jhidding and sjvrijn November 12, 2025 22:07

github-actions bot pushed a commit that referenced this pull request Nov 12, 2025

differences for PR #8

9685ca4

rogerkuou marked this pull request as ready for review November 13, 2025 08:45

sjvrijn requested changes Nov 13, 2025

View reviewed changes

update branch description

751a2e6

github-actions bot pushed a commit that referenced this pull request Nov 13, 2025

differences for PR #8

5eb9525

explain language dependencies

8111a7b

github-actions bot pushed a commit that referenced this pull request Nov 13, 2025

differences for PR #8

d1ac3cf

Apply suggestions from code review

df7433e

Co-authored-by: Sander van Rijn <svr003@gmail.com>

github-actions bot pushed a commit that referenced this pull request Nov 13, 2025

differences for PR #8

06fcf50

move dependency editing of toml file to 4.3 with uv

0163606

github-actions bot pushed a commit that referenced this pull request Nov 17, 2025

differences for PR #8

7b28baa

gh actions for mkdocs

b8347eb

github-actions bot pushed a commit that referenced this pull request Nov 17, 2025

differences for PR #8

bdf4da8

jhidding approved these changes Nov 17, 2025

View reviewed changes

fnattino approved these changes Nov 17, 2025

View reviewed changes

rogerkuou added 2 commits November 17, 2025 21:14

add a callout session for Python Packaging Guide

9340727

add a callout session for Python Packaging User Guide

467d819

rogerkuou merged commit 585e9b8 into main Nov 17, 2025
3 checks passed

github-actions bot pushed a commit that referenced this pull request Nov 17, 2025

differences for PR #8

ff5f5ed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update section 4#8

Update section 4#8
rogerkuou merged 25 commits intomainfrom
7_update_section_4_software_sustainability

rogerkuou commented Nov 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Nov 12, 2025 •

edited

Loading

Uh oh!

rogerkuou commented Nov 12, 2025

Uh oh!

sjvrijn left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rogerkuou commented Nov 17, 2025

Uh oh!

jhidding left a comment

Uh oh!

fnattino left a comment

Uh oh!

rogerkuou commented Nov 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

rogerkuou commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Thank you!

Rendered Changes

Uh oh!

rogerkuou commented Nov 12, 2025

Uh oh!

sjvrijn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rogerkuou commented Nov 17, 2025

Uh oh!

jhidding left a comment

Choose a reason for hiding this comment

Uh oh!

fnattino left a comment

Choose a reason for hiding this comment

Uh oh!

rogerkuou commented Nov 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rogerkuou commented Nov 12, 2025 •

edited

Loading

github-actions bot commented Nov 12, 2025 •

edited

Loading